cs-membership-user-migration icon

cs-membership-user-migration

1.0.x
(0 reviews)

📚 API Dictionary - CS Membership User Migration

This API Dictionary provides a comprehensive overview of the key components used in the CS Membership User Migration API.

🗂️ Base Information

🔐 Authentication Methods

  1. Client ID EnforcementRequires a valid client_id header for API requests.
  2. OAuth 2.0Secure token-based authentication using Bearer tokens in the Authorization header.

Example Authentication Headers:

bash

-H "client_id: YOUR_CLIENT_ID" \

-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

📍 Endpoints Overview

1️⃣ GET /obtain-users-by-b2c

  • Description: Retrieve user information based on the B2C identifier.
  • Method: GET
  • Path: /obtain-users-by-b2c
  • Query Parameter:
    • sub (string, required) - The unique B2C user identifier.
Example Request:
curl -X GET "https://cs-membership-user-migration-dev.us-e1.cloudhub.io/api/obtain-users-by-b2c?sub=4fbcdd2e-c284-4aa1-9320-ab72a21d4aaf" \
  -H "Content-Type: application/json" \
  -H "client_id: YOUR_CLIENT_ID" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Example Response:
{
  "id": "4fbcdd2e-c284-4aa1-9320-ab72a21d4aaf",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "status": "active"
}

🗃️ Query Parameters

  • sub (required): The user's B2C identifier (UUID format).
    • Example: 4fbcdd2e-c284-4aa1-9320-ab72a21d4aaf

📦 Response Fields

  • id (string): The unique identifier of the user.
  • name (string): Full name of the user.
  • email (string): Email address of the user.
  • status (string): Current status of the user (e.g., active, inactive).

⚠️ Error Handling

The API handles errors using standard HTTP status codes and structured error responses.

Example Error Response:

{
  "error": "invalid_request",
  "error_description": "Missing required parameter: sub"
}

Common HTTP Status Codes:

  • 200 OK - Request was successful.
  • 400 Bad Request - Invalid or missing parameters.
  • 401 Unauthorized - Authentication failed.
  • 404 Not Found - Resource not found.
  • 500 Internal Server Error - Unexpected server error.

📞 Support

For any questions or issues, please contact the API support team COORDINACION DESARROLLO DE SERVICIOS Y APLICACIONES DE INTEGRACIONES.

Notes

  • Documentation adjusted in February 2025.
  • For additional information, contact: epalma@fgs.co

Reviews